This PR is a test of the docs-builder changelog add, bundle, and render commands, which are documented in https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/changelog

In particular, it contains output files generated with the following fixes and enhancements applied elastic/docs-builder#2485 and elastic/docs-builder#2481

NOTE: The changelogs with the new format are put in a "new" sub-folder for the purposes of this test but that's not an indication of where they'll be stored in the long-term.

Procedure

This content was created by following these steps:

1. Re-create the changelogs with the new format. For example:

    docs-builder changelog add \
    --prs ./docs/elasticsearch-9.3.0.txt \
    --repo elasticsearch --owner elastic \
    --products "elasticsearch 9.3.0" \
    --config ./docs/changelog.yml \
    --output ./docs/changelog/new/ \
    --use-pr-number --strip-title-prefix

   Note that three of the PRs will fail to create changelogs due to their labels (i.e. two have the >non-issue label and one is missing any "type" labels).
2. Create a bundle of all the changelogs. This can be done based on a PR list, the changelog product metadata, or all changelogs in a folder. For example, based on PR list:

   docs-builder changelog bundle \
   --directory ./elasticsearch/docs/changelog/new \
   --output ./docs/release-notes/changelog-bundles/9.3.0.yaml \
   --prs ./docs/elasticsearch-9.3.0.txt \
   --output-products "elasticsearch 9.3.0 ga" \
   --repo elasticsearch --owner elastic
   --resolve

   Note that it will return a warning because of the three missing changelogs.
3. Generate docs:
   • Render the bundle as markdown snippets:

     docs-builder changelog render \
     --config ./docs/changelog.yml \
     --input "/path/to/elasticsearch/docs/release-notes/changelog-bundles/9.3.0.yaml|/path/to/elasticsearch/docs/changelog/new|elasticsearch|keep-links" \
     --output ./docs/release-notes/_snippets/ \
     --subsections

     Then add references to these snippets in the existing release note docs.
   • Alternatively, skip the markdown files and use changelog directives in the existing release note pages.
4. Test the addition of extra changelogs post-GA. For example, create a known issue changelog:

   docs-builder changelog add \
   --prs 139011 --repo elasticsearch --owner elastic \
   --products "elasticsearch 9.3.0 ga" \
   --config ./docs/changelog.yml \
   --output ./docs/changelog/new/ --use-pr-number --strip-title-prefix \
   --description "The bbq_disk index format, licensed under the Enterprise subscription tier was introduced in 9.2.0 without appropriate license enforcement. This allowed users to create and use bbq_disk indices without an Enterprise license. This will be addressed in version 9.3.0. Upon upgrading to 9.3+ indices created on 9.2 will still be available for updates and queries, but new indices created on 9.3+ will require an Enterprise license." \
   --type known-issue

5. Create a new bundle for the new changelogs:

    ./docs-builder changelog bundle-amend \
    ~/Documents/GitHub/elasticsearch/docs/changelog/new/bundles/9.3.0.yaml \
    --add ~/Documents/elasticsearch/docs/changelog/new/139011.yaml

6. If you're not using changelog directives, re-run the render command with both the old and new bundles:

   docs-builder changelog render \
   --config ./docs/changelog.yml \
   --input "/path/to/elasticsearch/docs/changelog/new/bundles/9.3.0.yaml|/path/to/elasticsearch/docs/changelog/new|elasticsearch|keep-links,/path/to/elasticsearch/docs/changelog/new/bundles/9.3.0.amend-1.yaml|/path/to/elasticsearch/docs/changelog/new|elasticsearch|keep-links" \
   --output ./docs/release-notes/_snippets/ \
   --subsections

   If you're using changelog directives, the new bundle is automatically picked up.